Get Location by Label
curl --request GET \
--url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locationsByLabel/{label} \
--header 'Authorization: Bearer <token>'{
"resource": {
"type": "Location",
"id": 42,
"label": "A4-55-C3",
"priority": 10,
"qty_putaway": 10,
"qty_unreserved": 20,
"qty_reserved": 4,
"qty_on_hand": 34,
"qty_locked": 4,
"is_temp": false,
"is_pickable": true,
"is_type_auto": true,
"created_at": "2021-11-17T14:32:44Z",
"updated_at": "2021-11-17T14:32:44Z",
"last_cyclecount_at": "2021-11-17T14:32:44Z",
"lot": {
"type": "Lot",
"id": 54
},
"product": {
"id": 123
},
"rack": {
"type": "Rack",
"id": 123
},
"location_type": {
"type": "LocationType",
"id": 54
}
},
"included": {
"LocationType": [
{
"type": "LocationType",
"id": 54,
"name": "Pickable Pallets",
"is_pickable": false,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
}
}
],
"Lot": [
{
"type": "Lot",
"id": 54
}
],
"LotType": [
{
"type": "LotType",
"id": 4,
"name": "MixFulfillment-Extract-Choose-FEFO",
"allow_mixing_locations": true,
"allow_mixing_fulfillment": true,
"lot_number_input": "text",
"lot_number_example": "AB190405G",
"lot_number_pattern": "^([A-Z]{2}-[0-9]+)$",
"lot_number_replacement": "$2$1",
"expiration_date": "lot_number_date",
"burn_order": "fefo",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Merchant": [
{
"type": "Merchant",
"id": 4,
"code": "acme_inc",
"name": "ACME Inc.",
"status": "active",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"brands": [
{
"type": "Brand",
"id": 4
}
],
"default_brand": {
"type": "Brand",
"id": 4
},
"custom_fields": {
"is_gift": {
"value": true
},
"order_details": {
"value": "test details"
},
"department": {
"id": 3,
"label": "Shipping"
},
"priority_levels": [
{
"id": 1,
"label": "Urgent"
},
{
"id": 2,
"label": "High"
}
],
"cost_of_goods": {
"amount": 156.99,
"currency": "USD"
},
"assigned_user": {
"value": 42
}
}
}
],
"PackagingContainer": [
{
"type": "PackagingContainer",
"id": 123,
"container_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_warehouses": [
{
"type": "Warehouse",
"id": 123
}
],
"allow_for_shipping_methods": [
"<string>"
],
"weight_capacity": {
"value": 20
},
"container_style": "rigid_box"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingDataCollection": [
{
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"type": "PackagingDataCollection",
"id": 123,
"data_collection_options": {
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"collect_data_pattern": "<string>",
"apply_to_region": "<string>"
}
}
],
"PackagingInfill": [
{
"type": "PackagingInfill",
"id": 123,
"infill_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"infill_horizontal": {
"value": 12
},
"infill_vertical": {
"value": 12
},
"infill_priority": 123
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingInstruction": [
{
"type": "PackagingInstruction",
"id": 123,
"instruction_options": {
"barcodes": "956623520-4",
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"apply_to_region": "<string>"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingSupplies": [
{
"type": "PackagingSupplies",
"id": 123,
"supplies_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_warehouses": [
{
"type": "Warehouse",
"id": 123
}
],
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"apply_to_region": "<string>"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Product": [
{
"type": "Product",
"id": 123,
"vendor_sku": "Vendor-SKU-1AD2",
"external_id": "11-993-9048",
"barcodes": [
"956623520-4",
"O-VS-Oregano-p3"
],
"is_available": true,
"is_visible": true,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"inventory": {
"backorders": true,
"dynamic_allocation": true,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": {
"value": 20
},
"container_type": "Plastic Box",
"container_meets_hazmat_specs": true,
"regulation_units": 5
},
"packaging": {
"require_packaging": true,
"require_weight_check": true,
"require_confirmation_per_item": true,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": true,
"ship_separately_tag": "PVC",
"can_tip": true,
"can_contain_other_items": true,
"is_handling_surcharge": true
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": true
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Rack": [
{
"type": "Rack",
"id": 54,
"rack_type": {
"type": "RackType",
"id": 123
}
}
],
"RackType": [
{
"type": "RackType",
"id": 1,
"name": "Wide Aisle",
"notes": "<string>"
}
],
"Warehouse": [
{
"type": "Warehouse",
"id": 3,
"name": "East Coast 1",
"is_active": true
}
]
}
}Locations
Get Location by Label
Returns a single Location object specified by the warehouse id and location label path parameters.
GET
/
v1
/
inventory
/
warehouses
/
{id}
/
locationsByLabel
/
{label}
Get Location by Label
curl --request GET \
--url https://{base_url_domain}/api/global/v1/inventory/warehouses/{id}/locationsByLabel/{label} \
--header 'Authorization: Bearer <token>'{
"resource": {
"type": "Location",
"id": 42,
"label": "A4-55-C3",
"priority": 10,
"qty_putaway": 10,
"qty_unreserved": 20,
"qty_reserved": 4,
"qty_on_hand": 34,
"qty_locked": 4,
"is_temp": false,
"is_pickable": true,
"is_type_auto": true,
"created_at": "2021-11-17T14:32:44Z",
"updated_at": "2021-11-17T14:32:44Z",
"last_cyclecount_at": "2021-11-17T14:32:44Z",
"lot": {
"type": "Lot",
"id": 54
},
"product": {
"id": 123
},
"rack": {
"type": "Rack",
"id": 123
},
"location_type": {
"type": "LocationType",
"id": 54
}
},
"included": {
"LocationType": [
{
"type": "LocationType",
"id": 54,
"name": "Pickable Pallets",
"is_pickable": false,
"slot_dimensions": {
"width": 48,
"height": 60,
"depth": 42
}
}
],
"Lot": [
{
"type": "Lot",
"id": 54
}
],
"LotType": [
{
"type": "LotType",
"id": 4,
"name": "MixFulfillment-Extract-Choose-FEFO",
"allow_mixing_locations": true,
"allow_mixing_fulfillment": true,
"lot_number_input": "text",
"lot_number_example": "AB190405G",
"lot_number_pattern": "^([A-Z]{2}-[0-9]+)$",
"lot_number_replacement": "$2$1",
"expiration_date": "lot_number_date",
"burn_order": "fefo",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Merchant": [
{
"type": "Merchant",
"id": 4,
"code": "acme_inc",
"name": "ACME Inc.",
"status": "active",
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"brands": [
{
"type": "Brand",
"id": 4
}
],
"default_brand": {
"type": "Brand",
"id": 4
},
"custom_fields": {
"is_gift": {
"value": true
},
"order_details": {
"value": "test details"
},
"department": {
"id": 3,
"label": "Shipping"
},
"priority_levels": [
{
"id": 1,
"label": "Urgent"
},
{
"id": 2,
"label": "High"
}
],
"cost_of_goods": {
"amount": 156.99,
"currency": "USD"
},
"assigned_user": {
"value": 42
}
}
}
],
"PackagingContainer": [
{
"type": "PackagingContainer",
"id": 123,
"container_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_warehouses": [
{
"type": "Warehouse",
"id": 123
}
],
"allow_for_shipping_methods": [
"<string>"
],
"weight_capacity": {
"value": 20
},
"container_style": "rigid_box"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingDataCollection": [
{
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z",
"type": "PackagingDataCollection",
"id": 123,
"data_collection_options": {
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"collect_data_pattern": "<string>",
"apply_to_region": "<string>"
}
}
],
"PackagingInfill": [
{
"type": "PackagingInfill",
"id": 123,
"infill_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"infill_horizontal": {
"value": 12
},
"infill_vertical": {
"value": 12
},
"infill_priority": 123
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingInstruction": [
{
"type": "PackagingInstruction",
"id": 123,
"instruction_options": {
"barcodes": "956623520-4",
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"apply_to_region": "<string>"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"PackagingSupplies": [
{
"type": "PackagingSupplies",
"id": 123,
"supplies_options": {
"barcodes": "956623520-4",
"weight": {
"value": 20
},
"associated_products": [
{
"type": "Product",
"id": 3
}
],
"allow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"disallow_for_brands": [
{
"type": "Merchant",
"id": 4
}
],
"billing_amount": {
"amount": 99,
"currency": "USD"
},
"allow_for_warehouses": [
{
"type": "Warehouse",
"id": 123
}
],
"allow_for_shipping_methods": [
"<string>"
],
"apply_only_above_weight": {
"value": 20
},
"apply_to_region": "<string>"
},
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Product": [
{
"type": "Product",
"id": 123,
"vendor_sku": "Vendor-SKU-1AD2",
"external_id": "11-993-9048",
"barcodes": [
"956623520-4",
"O-VS-Oregano-p3"
],
"is_available": true,
"is_visible": true,
"lot_type": {
"type": "LotType",
"id": 4
},
"weight": {
"value": 20
},
"dimensions": {
"length": 8,
"width": 6,
"height": 4
},
"volume": {
"value": 300
},
"inventory": {
"backorders": true,
"dynamic_allocation": true,
"virtual_inventory": "optimistic"
},
"export": {
"description": "Plastic children's toy with steel weights and ball bearings",
"customs_value": {
"amount": 99,
"currency": "USD"
},
"country_of_manufacture": "TW",
"hs_base_code": "8518.30",
"hs_country_extension": [
{
"country_id": "TW",
"extension": "002"
},
{
"country_id": "US",
"extension": "011"
}
]
},
"regulated_goods": {
"regulation": {
"type": "Regulation",
"id": 123
},
"technical_name": "Hydro Polymer Acetylene Coating",
"additional_information": "Flamable Liquid",
"net_weight": {
"value": 20
},
"container_type": "Plastic Box",
"container_meets_hazmat_specs": true,
"regulation_units": 5
},
"packaging": {
"require_packaging": true,
"require_weight_check": true,
"require_confirmation_per_item": true,
"unit_quantity": 1,
"bulk_quantity": 10,
"max_per_package": 15,
"is_ship_separately": true,
"ship_separately_tag": "PVC",
"can_tip": true,
"can_contain_other_items": true,
"is_handling_surcharge": true
},
"custom_fields": [
{
"code": "color",
"value": 13,
"label": "Red and Black"
},
{
"code": "cost_of_goods",
"value": 41.32
},
{
"code": "allow_mailer",
"value": true
}
],
"sku": "SKU-1AD",
"name": "Test Product",
"is_enabled": true,
"merchant": {
"type": "Merchant",
"id": 4
},
"created_at": "2017-07-21T17:32:28Z",
"updated_at": "2017-07-21T17:39:43Z"
}
],
"Rack": [
{
"type": "Rack",
"id": 54,
"rack_type": {
"type": "RackType",
"id": 123
}
}
],
"RackType": [
{
"type": "RackType",
"id": 1,
"name": "Wide Aisle",
"notes": "<string>"
}
],
"Warehouse": [
{
"type": "Warehouse",
"id": 3,
"name": "East Coast 1",
"is_active": true
}
]
}
}Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
The id of the referenced Warehouse.
The location's human-readable label and barcode value (without barcode prefix). Be sure to url-encode the the value to avoid special characters being interpreted as not part of the label.
Query Parameters
Specify additional fields of the Location object to be included in the response.
Available options:
basic, all, label, priority, qty_on_hand, qty_putaway, qty_unreserved, qty_reserved, qty_locked, is_temp, is_pickable, is_type_auto, created_at, updated_at, last_cyclecount_at, lot, product, rack, location_type Specify additional fields of the Lot object to be included in the response.
Available options:
basic, all, id, lot_number, origination_date, expiration_date, is_expired, is_active, lot_number_input, expiration_input, sort_value, days_until_expiration, sort_direction, group_value, created_at, updated_at, created_by, lot_type, product Specify additional fields of the Product or Packaging* object to be included in the response.
Available options:
basic, all, created_at, updated_at, container_options, supplies_options, data_collection_options, instruction_options, infill_options, vendor_sku, external_id, barcodes, goods_type, is_available, is_visible, weight, dimensions, volume, inventory, export, regulated_goods, packaging, custom_fields Specify additional fields of the Rack object to be included in the response.
Available options:
all, id, name, rack_type, location_pattern, picking_order, warehouse Specify additional fields of the LocationType object to be included in the response.
Available options:
basic, all, name, is_pickable, slot_dimensions, created_at, updated_at Response
OK
A Location describes a user-specified inventory address within a warehouse.
Show child attributes
Show child attributes
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
Show child attributes
Show child attributes
Was this page helpful?
āI